Skip to content

Fix one qubit gate docstrings to single standard, start gate zoo #5246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 26, 2022

Conversation

dabacon
Copy link
Collaborator

@dabacon dabacon commented Apr 12, 2022

This PR updates the doc strings for single qubit gates. These gates now all render correctly on quantumai.google.

  • This moves over to using LaTeX for the documentation. In some cases this makes the code doc string less readable, in some case it makes it is more readable. It renders nicely on quantumai.google

This also starts #852 for single qubit gates. Adding two and higher qubit gates will come in a follow up PR assuming the pattern in this PR is good.

@dabacon dabacon requested review from a team, vtomole and cduck as code owners April 12, 2022 00:38
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@dabacon dabacon requested a review from maffoo April 12, 2022 00:38
@CirqBot CirqBot added the size: XL lines changed >1000 label Apr 12, 2022
@MichaelBroughton MichaelBroughton self-assigned this Apr 21, 2022
Copy link
Collaborator

@MichaelBroughton MichaelBroughton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after nits.

Comment on lines 46 to 55
" <a target=\"_blank\" href=\"https://quantumai.google/cirq/qubits\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
" </td>\n",
" <td>\n",
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/qubits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
" </td>\n",
" <td>\n",
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/qubits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
" </td>\n",
" <td>\n",
" <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/qubits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Links out to wrong thing.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -11,7 +11,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 1,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why changes here ?

@dabacon dabacon added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Apr 26, 2022
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Apr 26, 2022
@CirqBot CirqBot merged commit f3e405b into quantumlib:master Apr 26, 2022
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Apr 26, 2022
rht pushed a commit to rht/Cirq that referenced this pull request May 1, 2023
…ntumlib#5246)

This PR updates the doc strings for single qubit gates.  These gates now all render correctly on quantumai.google.  

* This moves over to using LaTeX for the documentation. In some cases this makes the code doc string less readable, in some case it makes it is more readable.  It renders nicely on quantumai.google

This also starts quantumlib#852 for single qubit gates. Adding two and higher qubit gates will come in a follow up PR assuming the pattern in this PR is good.
harry-phasecraft pushed a commit to PhaseCraft/Cirq that referenced this pull request Oct 31, 2024
…ntumlib#5246)

This PR updates the doc strings for single qubit gates.  These gates now all render correctly on quantumai.google.  

* This moves over to using LaTeX for the documentation. In some cases this makes the code doc string less readable, in some case it makes it is more readable.  It renders nicely on quantumai.google

This also starts quantumlib#852 for single qubit gates. Adding two and higher qubit gates will come in a follow up PR assuming the pattern in this PR is good.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: XL lines changed >1000
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants